home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_xemacs.idb / usr / freeware / lib / xemacs-20.4 / info / lispref.info-20.z / lispref.info-20
Encoding:
GNU Info File  |  1998-05-21  |  49.6 KB  |  1,187 lines

  1. This is Info file ../../info/lispref.info, produced by Makeinfo version
  2. 1.68 from the input file lispref.texi.
  3.  
  4.    Edition History:
  5.  
  6.    GNU Emacs Lisp Reference Manual Second Edition (v2.01), May 1993 GNU
  7. Emacs Lisp Reference Manual Further Revised (v2.02), August 1993 Lucid
  8. Emacs Lisp Reference Manual (for 19.10) First Edition, March 1994
  9. XEmacs Lisp Programmer's Manual (for 19.12) Second Edition, April 1995
  10. GNU Emacs Lisp Reference Manual v2.4, June 1995 XEmacs Lisp
  11. Programmer's Manual (for 19.13) Third Edition, July 1995 XEmacs Lisp
  12. Reference Manual (for 19.14 and 20.0) v3.1, March 1996 XEmacs Lisp
  13. Reference Manual (for 19.15 and 20.1, 20.2) v3.2, April, May 1997
  14.  
  15.    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995 Free Software
  16. Foundation, Inc.  Copyright (C) 1994, 1995 Sun Microsystems, Inc.
  17. Copyright (C) 1995, 1996 Ben Wing.
  18.  
  19.    Permission is granted to make and distribute verbatim copies of this
  20. manual provided the copyright notice and this permission notice are
  21. preserved on all copies.
  22.  
  23.    Permission is granted to copy and distribute modified versions of
  24. this manual under the conditions for verbatim copying, provided that the
  25. entire resulting derived work is distributed under the terms of a
  26. permission notice identical to this one.
  27.  
  28.    Permission is granted to copy and distribute translations of this
  29. manual into another language, under the above conditions for modified
  30. versions, except that this permission notice may be stated in a
  31. translation approved by the Foundation.
  32.  
  33.    Permission is granted to copy and distribute modified versions of
  34. this manual under the conditions for verbatim copying, provided also
  35. that the section entitled "GNU General Public License" is included
  36. exactly as in the original, and provided that the entire resulting
  37. derived work is distributed under the terms of a permission notice
  38. identical to this one.
  39.  
  40.    Permission is granted to copy and distribute translations of this
  41. manual into another language, under the above conditions for modified
  42. versions, except that the section entitled "GNU General Public License"
  43. may be included in a translation approved by the Free Software
  44. Foundation instead of in the original English.
  45.  
  46. 
  47. File: lispref.info,  Node: Example Major Modes,  Next: Auto Major Mode,  Prev: Major Mode Conventions,  Up: Major Modes
  48.  
  49. Major Mode Examples
  50. -------------------
  51.  
  52.    Text mode is perhaps the simplest mode besides Fundamental mode.
  53. Here are excerpts from  `text-mode.el' that illustrate many of the
  54. conventions listed above:
  55.  
  56.      ;; Create mode-specific tables.
  57.      (defvar text-mode-syntax-table nil
  58.        "Syntax table used while in text mode.")
  59.  
  60.      (if text-mode-syntax-table
  61.          ()              ; Do not change the table if it is already set up.
  62.        (setq text-mode-syntax-table (make-syntax-table))
  63.        (modify-syntax-entry ?\" ".   " text-mode-syntax-table)
  64.        (modify-syntax-entry ?\\ ".   " text-mode-syntax-table)
  65.        (modify-syntax-entry ?' "w   " text-mode-syntax-table))
  66.  
  67.      (defvar text-mode-abbrev-table nil
  68.        "Abbrev table used while in text mode.")
  69.      (define-abbrev-table 'text-mode-abbrev-table ())
  70.  
  71.      (defvar text-mode-map nil)   ; Create a mode-specific keymap.
  72.      
  73.      (if text-mode-map
  74.          ()              ; Do not change the keymap if it is already set up.
  75.        (setq text-mode-map (make-sparse-keymap))
  76.        (define-key text-mode-map "\t" 'tab-to-tab-stop)
  77.        (define-key text-mode-map "\es" 'center-line)
  78.        (define-key text-mode-map "\eS" 'center-paragraph))
  79.  
  80.    Here is the complete major mode function definition for Text mode:
  81.  
  82.      (defun text-mode ()
  83.        "Major mode for editing text intended for humans to read.
  84.       Special commands: \\{text-mode-map}
  85.  
  86.      Turning on text-mode runs the hook `text-mode-hook'."
  87.        (interactive)
  88.        (kill-all-local-variables)
  89.  
  90.      (use-local-map text-mode-map)     ; This provides the local keymap.
  91.        (setq mode-name "Text")           ; This name goes into the modeline.
  92.        (setq major-mode 'text-mode)      ; This is how `describe-mode'
  93.                                          ;   finds the doc string to print.
  94.        (setq local-abbrev-table text-mode-abbrev-table)
  95.        (set-syntax-table text-mode-syntax-table)
  96.        (run-hooks 'text-mode-hook))      ; Finally, this permits the user to
  97.                                          ;   customize the mode with a hook.
  98.  
  99.    The three Lisp modes (Lisp mode, Emacs Lisp mode, and Lisp
  100. Interaction mode) have more features than Text mode and the code is
  101. correspondingly more complicated.  Here are excerpts from
  102. `lisp-mode.el' that illustrate how these modes are written.
  103.  
  104.      ;; Create mode-specific table variables.
  105.      (defvar lisp-mode-syntax-table nil "")
  106.      (defvar emacs-lisp-mode-syntax-table nil "")
  107.      (defvar lisp-mode-abbrev-table nil "")
  108.  
  109.      (if (not emacs-lisp-mode-syntax-table) ; Do not change the table
  110.                                             ;   if it is already set.
  111.          (let ((i 0))
  112.            (setq emacs-lisp-mode-syntax-table (make-syntax-table))
  113.  
  114.      ;; Set syntax of chars up to 0 to class of chars that are
  115.            ;;   part of symbol names but not words.
  116.            ;;   (The number 0 is `48' in the ASCII character set.)
  117.            (while (< i ?0)
  118.              (modify-syntax-entry i "_   " emacs-lisp-mode-syntax-table)
  119.              (setq i (1+ i)))
  120.            ...
  121.  
  122.      ;; Set the syntax for other characters.
  123.            (modify-syntax-entry ?  "    " emacs-lisp-mode-syntax-table)
  124.            (modify-syntax-entry ?\t "    " emacs-lisp-mode-syntax-table)
  125.            ...
  126.  
  127.      (modify-syntax-entry ?\( "()  " emacs-lisp-mode-syntax-table)
  128.            (modify-syntax-entry ?\) ")(  " emacs-lisp-mode-syntax-table)
  129.            ...))
  130.      ;; Create an abbrev table for lisp-mode.
  131.      (define-abbrev-table 'lisp-mode-abbrev-table ())
  132.  
  133.    Much code is shared among the three Lisp modes.  The following
  134. function sets various variables; it is called by each of the major Lisp
  135. mode functions:
  136.  
  137.      (defun lisp-mode-variables (lisp-syntax)
  138.        ;; The `lisp-syntax' argument is `nil' in Emacs Lisp mode,
  139.        ;;   and `t' in the other two Lisp modes.
  140.        (cond (lisp-syntax
  141.               (if (not lisp-mode-syntax-table)
  142.                   ;; The Emacs Lisp mode syntax table always exists, but
  143.                   ;;   the Lisp Mode syntax table is created the first time a
  144.                   ;;   mode that needs it is called.  This is to save space.
  145.  
  146.      (progn (setq lisp-mode-syntax-table
  147.                             (copy-syntax-table emacs-lisp-mode-syntax-table))
  148.                          ;; Change some entries for Lisp mode.
  149.                          (modify-syntax-entry ?\| "\"   "
  150.                                               lisp-mode-syntax-table)
  151.                          (modify-syntax-entry ?\[ "_   "
  152.                                               lisp-mode-syntax-table)
  153.                          (modify-syntax-entry ?\] "_   "
  154.                                               lisp-mode-syntax-table)))
  155.  
  156.      (set-syntax-table lisp-mode-syntax-table)))
  157.        (setq local-abbrev-table lisp-mode-abbrev-table)
  158.        ...)
  159.  
  160.    Functions such as `forward-paragraph' use the value of the
  161. `paragraph-start' variable.  Since Lisp code is different from ordinary
  162. text, the `paragraph-start' variable needs to be set specially to
  163. handle Lisp.  Also, comments are indented in a special fashion in Lisp
  164. and the Lisp modes need their own mode-specific
  165. `comment-indent-function'.  The code to set these variables is the rest
  166. of `lisp-mode-variables'.
  167.  
  168.      (make-local-variable 'paragraph-start)
  169.        ;; Having `^' is not clean, but `page-delimiter'
  170.        ;; has them too, and removing those is a pain.
  171.        (setq paragraph-start (concat "^$\\|" page-delimiter))
  172.        ...
  173.  
  174.      (make-local-variable 'comment-indent-function)
  175.        (setq comment-indent-function 'lisp-comment-indent))
  176.  
  177.    Each of the different Lisp modes has a slightly different keymap.
  178. For example, Lisp mode binds `C-c C-l' to `run-lisp', but the other
  179. Lisp modes do not.  However, all Lisp modes have some commands in
  180. common.  The following function adds these common commands to a given
  181. keymap.
  182.  
  183.      (defun lisp-mode-commands (map)
  184.        (define-key map "\e\C-q" 'indent-sexp)
  185.        (define-key map "\177" 'backward-delete-char-untabify)
  186.        (define-key map "\t" 'lisp-indent-line))
  187.  
  188.    Here is an example of using `lisp-mode-commands' to initialize a
  189. keymap, as part of the code for Emacs Lisp mode.  First we declare a
  190. variable with `defvar' to hold the mode-specific keymap.  When this
  191. `defvar' executes, it sets the variable to `nil' if it was void.  Then
  192. we set up the keymap if the variable is `nil'.
  193.  
  194.    This code avoids changing the keymap or the variable if it is already
  195. set up.  This lets the user customize the keymap.
  196.  
  197.      (defvar emacs-lisp-mode-map () "")
  198.      (if emacs-lisp-mode-map
  199.          ()
  200.        (setq emacs-lisp-mode-map (make-sparse-keymap))
  201.        (define-key emacs-lisp-mode-map "\e\C-x" 'eval-defun)
  202.        (lisp-mode-commands emacs-lisp-mode-map))
  203.  
  204.    Finally, here is the complete major mode function definition for
  205. Emacs Lisp mode.
  206.  
  207.      (defun emacs-lisp-mode ()
  208.        "Major mode for editing Lisp code to run in XEmacs.
  209.      Commands:
  210.      Delete converts tabs to spaces as it moves back.
  211.      Blank lines separate paragraphs.  Semicolons start comments.
  212.      \\{emacs-lisp-mode-map}
  213.  
  214.      Entry to this mode runs the hook `emacs-lisp-mode-hook'."
  215.        (interactive)
  216.        (kill-all-local-variables)
  217.        (use-local-map emacs-lisp-mode-map)    ; This provides the local keymap.
  218.        (set-syntax-table emacs-lisp-mode-syntax-table)
  219.  
  220.      (setq major-mode 'emacs-lisp-mode)     ; This is how `describe-mode'
  221.                                               ;   finds out what to describe.
  222.        (setq mode-name "Emacs-Lisp")          ; This goes into the modeline.
  223.        (lisp-mode-variables nil)              ; This defines various variables.
  224.        (run-hooks 'emacs-lisp-mode-hook))     ; This permits the user to use a
  225.                                               ;   hook to customize the mode.
  226.  
  227. 
  228. File: lispref.info,  Node: Auto Major Mode,  Next: Mode Help,  Prev: Example Major Modes,  Up: Major Modes
  229.  
  230. How XEmacs Chooses a Major Mode
  231. -------------------------------
  232.  
  233.    Based on information in the file name or in the file itself, XEmacs
  234. automatically selects a major mode for the new buffer when a file is
  235. visited.
  236.  
  237.  - Command: fundamental-mode
  238.      Fundamental mode is a major mode that is not specialized for
  239.      anything in particular.  Other major modes are defined in effect
  240.      by comparison with this one--their definitions say what to change,
  241.      starting from Fundamental mode.  The `fundamental-mode' function
  242.      does *not* run any hooks; you're not supposed to customize it.
  243.      (If you want Emacs to behave differently in Fundamental mode,
  244.      change the *global* state of Emacs.)
  245.  
  246.  - Command: normal-mode &optional FIND-FILE
  247.      This function establishes the proper major mode and local variable
  248.      bindings for the current buffer.  First it calls `set-auto-mode',
  249.      then it runs `hack-local-variables' to parse, and bind or evaluate
  250.      as appropriate, any local variables.
  251.  
  252.      If the FIND-FILE argument to `normal-mode' is non-`nil',
  253.      `normal-mode' assumes that the `find-file' function is calling it.
  254.      In this case, it may process a local variables list at the end of
  255.      the file and in the `-*-' line.  The variable
  256.      `enable-local-variables' controls whether to do so.
  257.  
  258.      If you run `normal-mode' interactively, the argument FIND-FILE is
  259.      normally `nil'.  In this case, `normal-mode' unconditionally
  260.      processes any local variables list.  *Note Local Variables in
  261.      Files: (emacs)File variables, for the syntax of the local
  262.      variables section of a file.
  263.  
  264.      `normal-mode' uses `condition-case' around the call to the major
  265.      mode function, so errors are caught and reported as a `File mode
  266.      specification error',  followed by the original error message.
  267.  
  268.  - User Option: enable-local-variables
  269.      This variable controls processing of local variables lists in files
  270.      being visited.  A value of `t' means process the local variables
  271.      lists unconditionally; `nil' means ignore them; anything else means
  272.      ask the user what to do for each file.  The default value is `t'.
  273.  
  274.  - Variable: ignored-local-variables
  275.      This variable holds a list of variables that should not be set by
  276.      a local variables list.  Any value specified for one of these
  277.      variables is ignored.
  278.  
  279.    In addition to this list, any variable whose name has a non-`nil'
  280. `risky-local-variable' property is also ignored.
  281.  
  282.  - User Option: enable-local-eval
  283.      This variable controls processing of `Eval:' in local variables
  284.      lists in files being visited.  A value of `t' means process them
  285.      unconditionally; `nil' means ignore them; anything else means ask
  286.      the user what to do for each file.  The default value is `maybe'.
  287.  
  288.  - Function: set-auto-mode
  289.      This function selects the major mode that is appropriate for the
  290.      current buffer.  It may base its decision on the value of the `-*-'
  291.      line, on the visited file name (using `auto-mode-alist'), or on the
  292.      value of a local variable.  However, this function does not look
  293.      for the `mode:' local variable near the end of a file; the
  294.      `hack-local-variables' function does that.  *Note How Major Modes
  295.      are Chosen: (emacs)Choosing Modes.
  296.  
  297.  - User Option: default-major-mode
  298.      This variable holds the default major mode for new buffers.  The
  299.      standard value is `fundamental-mode'.
  300.  
  301.      If the value of `default-major-mode' is `nil', XEmacs uses the
  302.      (previously) current buffer's major mode for the major mode of a
  303.      new buffer.  However, if the major mode symbol has a `mode-class'
  304.      property with value `special', then it is not used for new buffers;
  305.      Fundamental mode is used instead.  The modes that have this
  306.      property are those such as Dired and Rmail that are useful only
  307.      with text that has been specially prepared.
  308.  
  309.  - Function: set-buffer-major-mode BUFFER
  310.      This function sets the major mode of BUFFER to the value of
  311.      `default-major-mode'.  If that variable is `nil', it uses the
  312.      current buffer's major mode (if that is suitable).
  313.  
  314.      The low-level primitives for creating buffers do not use this
  315.      function, but medium-level commands such as `switch-to-buffer' and
  316.      `find-file-noselect' use it whenever they create buffers.
  317.  
  318.  - Variable: initial-major-mode
  319.      The value of this variable determines the major mode of the initial
  320.      `*scratch*' buffer.  The value should be a symbol that is a major
  321.      mode command name.  The default value is `lisp-interaction-mode'.
  322.  
  323.  - Variable: auto-mode-alist
  324.      This variable contains an association list of file name patterns
  325.      (regular expressions; *note Regular Expressions::.) and
  326.      corresponding major mode functions.  Usually, the file name
  327.      patterns test for suffixes, such as `.el' and `.c', but this need
  328.      not be the case.  An ordinary element of the alist looks like
  329.      `(REGEXP .  MODE-FUNCTION)'.
  330.  
  331.      For example,
  332.  
  333.           (("^/tmp/fol/" . text-mode)
  334.            ("\\.texinfo\\'" . texinfo-mode)
  335.            ("\\.texi\\'" . texinfo-mode)
  336.  
  337.           ("\\.el\\'" . emacs-lisp-mode)
  338.            ("\\.c\\'" . c-mode)
  339.            ("\\.h\\'" . c-mode)
  340.            ...)
  341.  
  342.      When you visit a file whose expanded file name (*note File Name
  343.      Expansion::.) matches a REGEXP, `set-auto-mode' calls the
  344.      corresponding MODE-FUNCTION.  This feature enables XEmacs to select
  345.      the proper major mode for most files.
  346.  
  347.      If an element of `auto-mode-alist' has the form `(REGEXP FUNCTION
  348.      t)', then after calling FUNCTION, XEmacs searches
  349.      `auto-mode-alist' again for a match against the portion of the file
  350.      name that did not match before.
  351.  
  352.      This match-again feature is useful for uncompression packages: an
  353.      entry of the form `("\\.gz\\'" . FUNCTION)' can uncompress the file
  354.      and then put the uncompressed file in the proper mode according to
  355.      the name sans `.gz'.
  356.  
  357.      Here is an example of how to prepend several pattern pairs to
  358.      `auto-mode-alist'.  (You might use this sort of expression in your
  359.      `.emacs' file.)
  360.  
  361.           (setq auto-mode-alist
  362.             (append
  363.              ;; File name starts with a dot.
  364.              '(("/\\.[^/]*\\'" . fundamental-mode)
  365.                ;; File name has no dot.
  366.                ("[^\\./]*\\'" . fundamental-mode)
  367.                ;; File name ends in `.C'.
  368.                ("\\.C\\'" . c++-mode))
  369.              auto-mode-alist))
  370.  
  371.  - Variable: interpreter-mode-alist
  372.      This variable specifes major modes to use for scripts that specify
  373.      a command interpreter in an `#!' line.  Its value is a list of
  374.      elements of the form `(INTERPRETER . MODE)'; for example, `("perl"
  375.      . perl-mode)' is one element present by default.  The element says
  376.      to use mode MODE if the file specifies INTERPRETER.
  377.  
  378.      This variable is applicable only when the `auto-mode-alist' does
  379.      not indicate which major mode to use.
  380.  
  381.  - Function: hack-local-variables &optional FORCE
  382.      This function parses, and binds or evaluates as appropriate, any
  383.      local variables for the current buffer.
  384.  
  385.      The handling of `enable-local-variables' documented for
  386.      `normal-mode' actually takes place here.  The argument FORCE
  387.      usually comes from the argument FIND-FILE given to `normal-mode'.
  388.  
  389. 
  390. File: lispref.info,  Node: Mode Help,  Next: Derived Modes,  Prev: Auto Major Mode,  Up: Major Modes
  391.  
  392. Getting Help about a Major Mode
  393. -------------------------------
  394.  
  395.    The `describe-mode' function is used to provide information about
  396. major modes.  It is normally called with `C-h m'.  The `describe-mode'
  397. function uses the value of `major-mode', which is why every major mode
  398. function needs to set the `major-mode' variable.
  399.  
  400.  - Command: describe-mode
  401.      This function displays the documentation of the current major mode.
  402.  
  403.      The `describe-mode' function calls the `documentation' function
  404.      using the value of `major-mode' as an argument.  Thus, it displays
  405.      the documentation string of the major mode function.  (*Note
  406.      Accessing Documentation::.)
  407.  
  408.  - Variable: major-mode
  409.      This variable holds the symbol for the current buffer's major mode.
  410.      This symbol should have a function definition that is the command
  411.      to switch to that major mode.  The `describe-mode' function uses
  412.      the documentation string of the function as the documentation of
  413.      the major mode.
  414.  
  415. 
  416. File: lispref.info,  Node: Derived Modes,  Prev: Mode Help,  Up: Major Modes
  417.  
  418. Defining Derived Modes
  419. ----------------------
  420.  
  421.    It's often useful to define a new major mode in terms of an existing
  422. one.  An easy way to do this is to use `define-derived-mode'.
  423.  
  424.  - Macro: define-derived-mode VARIANT PARENT NAME DOCSTRING BODY...
  425.      This construct defines VARIANT as a major mode command, using NAME
  426.      as the string form of the mode name.
  427.  
  428.      The new command VARIANT is defined to call the function PARENT,
  429.      then override certain aspects of that parent mode:
  430.  
  431.         * The new mode has its own keymap, named `VARIANT-map'.
  432.           `define-derived-mode' initializes this map to inherit from
  433.           `PARENT-map', if it is not already set.
  434.  
  435.         * The new mode has its own syntax table, kept in the variable
  436.           `VARIANT-syntax-table'.  `define-derived-mode' initializes
  437.           this variable by copying `PARENT-syntax-table', if it is not
  438.           already set.
  439.  
  440.         * The new mode has its own abbrev table, kept in the variable
  441.           `VARIANT-abbrev-table'.  `define-derived-mode' initializes
  442.           this variable by copying `PARENT-abbrev-table', if it is not
  443.           already set.
  444.  
  445.         * The new mode has its own mode hook, `VARIANT-hook', which it
  446.           runs in standard fashion as the very last thing that it does.
  447.           (The new mode also runs the mode hook of PARENT as part of
  448.           calling PARENT.)
  449.  
  450.      In addition, you can specify how to override other aspects of
  451.      PARENT with BODY.  The command VARIANT evaluates the forms in BODY
  452.      after setting up all its usual overrides, just before running
  453.      `VARIANT-hook'.
  454.  
  455.      The argument DOCSTRING specifies the documentation string for the
  456.      new mode.  If you omit DOCSTRING, `define-derived-mode' generates
  457.      a documentation string.
  458.  
  459.      Here is a hypothetical example:
  460.  
  461.           (define-derived-mode hypertext-mode
  462.             text-mode "Hypertext"
  463.             "Major mode for hypertext.
  464.           \\{hypertext-mode-map}"
  465.             (setq case-fold-search nil))
  466.           
  467.           (define-key hypertext-mode-map
  468.             [down-mouse-3] 'do-hyper-link)
  469.  
  470. 
  471. File: lispref.info,  Node: Minor Modes,  Next: Modeline Format,  Prev: Major Modes,  Up: Modes
  472.  
  473. Minor Modes
  474. ===========
  475.  
  476.    A "minor mode" provides features that users may enable or disable
  477. independently of the choice of major mode.  Minor modes can be enabled
  478. individually or in combination.  Minor modes would be better named
  479. "Generally available, optional feature modes" except that such a name is
  480. unwieldy.
  481.  
  482.    A minor mode is not usually a modification of single major mode.  For
  483. example, Auto Fill mode may be used in any major mode that permits text
  484. insertion.  To be general, a minor mode must be effectively independent
  485. of the things major modes do.
  486.  
  487.    A minor mode is often much more difficult to implement than a major
  488. mode.  One reason is that you should be able to activate and deactivate
  489. minor modes in any order.  A minor mode should be able to have its
  490. desired effect regardless of the major mode and regardless of the other
  491. minor modes in effect.
  492.  
  493.    Often the biggest problem in implementing a minor mode is finding a
  494. way to insert the necessary hook into the rest of XEmacs.  Minor mode
  495. keymaps make this easier than it used to be.
  496.  
  497. * Menu:
  498.  
  499. * Minor Mode Conventions::      Tips for writing a minor mode.
  500. * Keymaps and Minor Modes::     How a minor mode can have its own keymap.
  501.  
  502. 
  503. File: lispref.info,  Node: Minor Mode Conventions,  Next: Keymaps and Minor Modes,  Up: Minor Modes
  504.  
  505. Conventions for Writing Minor Modes
  506. -----------------------------------
  507.  
  508.    There are conventions for writing minor modes just as there are for
  509. major modes.  Several of the major mode conventions apply to minor
  510. modes as well: those regarding the name of the mode initialization
  511. function, the names of global symbols, and the use of keymaps and other
  512. tables.
  513.  
  514.    In addition, there are several conventions that are specific to
  515. minor modes.
  516.  
  517.    * Make a variable whose name ends in `-mode' to represent the minor
  518.      mode.  Its value should enable or disable the mode (`nil' to
  519.      disable; anything else to enable.)  We call this the "mode
  520.      variable".
  521.  
  522.      This variable is used in conjunction with the `minor-mode-alist' to
  523.      display the minor mode name in the modeline.  It can also enable
  524.      or disable a minor mode keymap.  Individual commands or hooks can
  525.      also check the variable's value.
  526.  
  527.      If you want the minor mode to be enabled separately in each buffer,
  528.      make the variable buffer-local.
  529.  
  530.    * Define a command whose name is the same as the mode variable.  Its
  531.      job is to enable and disable the mode by setting the variable.
  532.  
  533.      The command should accept one optional argument.  If the argument
  534.      is `nil', it should toggle the mode (turn it on if it is off, and
  535.      off if it is on).  Otherwise, it should turn the mode on if the
  536.      argument is a positive integer, a symbol other than `nil' or `-',
  537.      or a list whose CAR is such an integer or symbol; it should turn
  538.      the mode off otherwise.
  539.  
  540.      Here is an example taken from the definition of
  541.      `transient-mark-mode'.  It shows the use of `transient-mark-mode'
  542.      as a variable that enables or disables the mode's behavior, and
  543.      also shows the proper way to toggle, enable or disable the minor
  544.      mode based on the raw prefix argument value.
  545.  
  546.           (setq transient-mark-mode
  547.                 (if (null arg) (not transient-mark-mode)
  548.                   (> (prefix-numeric-value arg) 0)))
  549.  
  550.    * Add an element to `minor-mode-alist' for each minor mode (*note
  551.      Modeline Variables::.).  This element should be a list of the
  552.      following form:
  553.  
  554.           (MODE-VARIABLE STRING)
  555.  
  556.      Here MODE-VARIABLE is the variable that controls enabling of the
  557.      minor mode, and STRING is a short string, starting with a space,
  558.      to represent the mode in the modeline.  These strings must be
  559.      short so that there is room for several of them at once.
  560.  
  561.      When you add an element to `minor-mode-alist', use `assq' to check
  562.      for an existing element, to avoid duplication.  For example:
  563.  
  564.           (or (assq 'leif-mode minor-mode-alist)
  565.               (setq minor-mode-alist
  566.                     (cons '(leif-mode " Leif") minor-mode-alist)))
  567.  
  568. 
  569. File: lispref.info,  Node: Keymaps and Minor Modes,  Prev: Minor Mode Conventions,  Up: Minor Modes
  570.  
  571. Keymaps and Minor Modes
  572. -----------------------
  573.  
  574.    Each minor mode can have its own keymap, which is active when the
  575. mode is enabled.  To set up a keymap for a minor mode, add an element
  576. to the alist `minor-mode-map-alist'.  *Note Active Keymaps::.
  577.  
  578.    One use of minor mode keymaps is to modify the behavior of certain
  579. self-inserting characters so that they do something else as well as
  580. self-insert.  In general, this is the only way to do that, since the
  581. facilities for customizing `self-insert-command' are limited to special
  582. cases (designed for abbrevs and Auto Fill mode).  (Do not try
  583. substituting your own definition of `self-insert-command' for the
  584. standard one.  The editor command loop handles this function specially.)
  585.  
  586. 
  587. File: lispref.info,  Node: Modeline Format,  Next: Hooks,  Prev: Minor Modes,  Up: Modes
  588.  
  589. Modeline Format
  590. ===============
  591.  
  592.    Each Emacs window (aside from minibuffer windows) includes a
  593. modeline, which displays status information about the buffer displayed
  594. in the window.  The modeline contains information about the buffer,
  595. such as its name, associated file, depth of recursive editing, and the
  596. major and minor modes.
  597.  
  598.    This section describes how the contents of the modeline are
  599. controlled.  It is in the chapter on modes because much of the
  600. information displayed in the modeline relates to the enabled major and
  601. minor modes.
  602.  
  603.    `modeline-format' is a buffer-local variable that holds a template
  604. used to display the modeline of the current buffer.  All windows for
  605. the same buffer use the same `modeline-format' and their modelines
  606. appear the same (except for scrolling percentages and line numbers).
  607.  
  608.    The modeline of a window is normally updated whenever a different
  609. buffer is shown in the window, or when the buffer's modified-status
  610. changes from `nil' to `t' or vice-versa.  If you modify any of the
  611. variables referenced by `modeline-format' (*note Modeline
  612. Variables::.), you may want to force an update of the modeline so as to
  613. display the new information.
  614.  
  615.  - Function: redraw-modeline &optional ALL
  616.      Force redisplay of the current buffer's modeline.  If ALL is
  617.      non-`nil', then force redisplay of all modelines.
  618.  
  619.    The modeline is usually displayed in inverse video.  This is
  620. controlled using the `modeline' face.  *Note Faces::.
  621.  
  622. * Menu:
  623.  
  624. * Modeline Data::         The data structure that controls the modeline.
  625. * Modeline Variables::    Variables used in that data structure.
  626. * %-Constructs::          Putting information into a modeline.
  627.  
  628. 
  629. File: lispref.info,  Node: Modeline Data,  Next: Modeline Variables,  Up: Modeline Format
  630.  
  631. The Data Structure of the Modeline
  632. ----------------------------------
  633.  
  634.    The modeline contents are controlled by a data structure of lists,
  635. strings, symbols, and numbers kept in the buffer-local variable
  636. `mode-line-format'.  The data structure is called a "modeline
  637. construct", and it is built in recursive fashion out of simpler modeline
  638. constructs.  The same data structure is used for constructing frame
  639. titles (*note Frame Titles::.).
  640.  
  641.  - Variable: modeline-format
  642.      The value of this variable is a modeline construct with overall
  643.      responsibility for the modeline format.  The value of this variable
  644.      controls which other variables are used to form the modeline text,
  645.      and where they appear.
  646.  
  647.    A modeline construct may be as simple as a fixed string of text, but
  648. it usually specifies how to use other variables to construct the text.
  649. Many of these variables are themselves defined to have modeline
  650. constructs as their values.
  651.  
  652.    The default value of `modeline-format' incorporates the values of
  653. variables such as `mode-name' and `minor-mode-alist'.  Because of this,
  654. very few modes need to alter `modeline-format'.  For most purposes, it
  655. is sufficient to alter the variables referenced by `modeline-format'.
  656.  
  657.    A modeline construct may be a list, a symbol, or a string.  If the
  658. value is a list, each element may be a list, a symbol, or a string.
  659.  
  660. `STRING'
  661.      A string as a modeline construct is displayed verbatim in the mode
  662.      line except for "`%'-constructs".  Decimal digits after the `%'
  663.      specify the field width for space filling on the right (i.e., the
  664.      data is left justified).  *Note %-Constructs::.
  665.  
  666. `SYMBOL'
  667.      A symbol as a modeline construct stands for its value.  The value
  668.      of SYMBOL is used as a modeline construct, in place of SYMBOL.
  669.      However, the symbols `t' and `nil' are ignored; so is any symbol
  670.      whose value is void.
  671.  
  672.      There is one exception: if the value of SYMBOL is a string, it is
  673.      displayed verbatim: the `%'-constructs are not recognized.
  674.  
  675. `(STRING REST...) or (LIST REST...)'
  676.      A list whose first element is a string or list means to process
  677.      all the elements recursively and concatenate the results.  This is
  678.      the most common form of mode line construct.
  679.  
  680. `(SYMBOL THEN ELSE)'
  681.      A list whose first element is a symbol is a conditional.  Its
  682.      meaning depends on the value of SYMBOL.  If the value is non-`nil',
  683.      the second element, THEN, is processed recursively as a modeline
  684.      element.  But if the value of SYMBOL is `nil', the third element,
  685.      ELSE, is processed recursively.  You may omit ELSE; then the mode
  686.      line element displays nothing if the value of SYMBOL is `nil'.
  687.  
  688. `(WIDTH REST...)'
  689.      A list whose first element is an integer specifies truncation or
  690.      padding of the results of REST.  The remaining elements REST are
  691.      processed recursively as modeline constructs and concatenated
  692.      together.  Then the result is space filled (if WIDTH is positive)
  693.      or truncated (to -WIDTH columns, if WIDTH is negative) on the
  694.      right.
  695.  
  696.      For example, the usual way to show what percentage of a buffer is
  697.      above the top of the window is to use a list like this: `(-3
  698.      "%p")'.
  699.  
  700.    If you do alter `modeline-format' itself, the new value should use
  701. the same variables that appear in the default value (*note Modeline
  702. Variables::.), rather than duplicating their contents or displaying the
  703. information in another fashion.  This way, customizations made by the
  704. user or by Lisp programs (such as `display-time' and major modes) via
  705. changes to those variables remain effective.
  706.  
  707.    Here is an example of a `modeline-format' that might be useful for
  708. `shell-mode', since it contains the hostname and default directory.
  709.  
  710.      (setq modeline-format
  711.        (list ""
  712.         'modeline-modified
  713.         "%b--"
  714.         (getenv "HOST")      ; One element is not constant.
  715.         ":"
  716.         'default-directory
  717.         "   "
  718.         'global-mode-string
  719.         "   %[("
  720.         'mode-name
  721.         'modeline-process
  722.         'minor-mode-alist
  723.         "%n"
  724.         ")%]----"
  725.         '(line-number-mode "L%l--")
  726.         '(-3 . "%p")
  727.         "-%-"))
  728.  
  729. 
  730. File: lispref.info,  Node: Modeline Variables,  Next: %-Constructs,  Prev: Modeline Data,  Up: Modeline Format
  731.  
  732. Variables Used in the Modeline
  733. ------------------------------
  734.  
  735.    This section describes variables incorporated by the standard value
  736. of `modeline-format' into the text of the mode line.  There is nothing
  737. inherently special about these variables; any other variables could
  738. have the same effects on the modeline if `modeline-format' were changed
  739. to use them.
  740.  
  741.  - Variable: modeline-modified
  742.      This variable holds the value of the modeline construct that
  743.      displays whether the current buffer is modified.
  744.  
  745.      The default value of `modeline-modified' is `("--%1*%1+-")'.  This
  746.      means that the modeline displays `--**-' if the buffer is
  747.      modified, `-----' if the buffer is not modified, `--%%-' if the
  748.      buffer is read only, and `--%*--' if the buffer is read only and
  749.      modified.
  750.  
  751.      Changing this variable does not force an update of the modeline.
  752.  
  753.  - Variable: modeline-buffer-identification
  754.      This variable identifies the buffer being displayed in the window.
  755.      Its default value is `("%F: %17b")', which means that it usually
  756.      displays `Emacs:' followed by seventeen characters of the buffer
  757.      name.  (In a terminal frame, it displays the frame name instead of
  758.      `Emacs'; this has the effect of showing the frame number.)  You may
  759.      want to change this in modes such as Rmail that do not behave like
  760.      a "normal" XEmacs.
  761.  
  762.  - Variable: global-mode-string
  763.      This variable holds a modeline spec that appears in the mode line
  764.      by default, just after the buffer name.  The command `display-time'
  765.      sets `global-mode-string' to refer to the variable
  766.      `display-time-string', which holds a string containing the time and
  767.      load information.
  768.  
  769.      The `%M' construct substitutes the value of `global-mode-string',
  770.      but this is obsolete, since the variable is included directly in
  771.      the modeline.
  772.  
  773.  - Variable: mode-name
  774.      This buffer-local variable holds the "pretty" name of the current
  775.      buffer's major mode.  Each major mode should set this variable so
  776.      that the mode name will appear in the modeline.
  777.  
  778.  - Variable: minor-mode-alist
  779.      This variable holds an association list whose elements specify how
  780.      the modeline should indicate that a minor mode is active.  Each
  781.      element of the `minor-mode-alist' should be a two-element list:
  782.  
  783.           (MINOR-MODE-VARIABLE MODELINE-STRING)
  784.  
  785.      More generally, MODELINE-STRING can be any mode line spec.  It
  786.      appears in the mode line when the value of MINOR-MODE-VARIABLE is
  787.      non-`nil', and not otherwise.  These strings should begin with
  788.      spaces so that they don't run together.  Conventionally, the
  789.      MINOR-MODE-VARIABLE for a specific mode is set to a non-`nil'
  790.      value when that minor mode is activated.
  791.  
  792.      The default value of `minor-mode-alist' is:
  793.  
  794.           minor-mode-alist
  795.           => ((vc-mode vc-mode)
  796.               (abbrev-mode " Abbrev")
  797.               (overwrite-mode overwrite-mode)
  798.               (auto-fill-function " Fill")
  799.               (defining-kbd-macro " Def")
  800.               (isearch-mode isearch-mode))
  801.  
  802.      `minor-mode-alist' is not buffer-local.  The variables mentioned
  803.      in the alist should be buffer-local if the minor mode can be
  804.      enabled separately in each buffer.
  805.  
  806.  - Variable: modeline-process
  807.      This buffer-local variable contains the modeline information on
  808.      process status in modes used for communicating with subprocesses.
  809.      It is displayed immediately following the major mode name, with no
  810.      intervening space.  For example, its value in the `*shell*' buffer
  811.      is `(": %s")', which allows the shell to display its status along
  812.      with the major mode as: `(Shell: run)'.  Normally this variable is
  813.      `nil'.
  814.  
  815.  - Variable: default-modeline-format
  816.      This variable holds the default `modeline-format' for buffers that
  817.      do not override it.  This is the same as `(default-value
  818.      'modeline-format)'.
  819.  
  820.      The default value of `default-modeline-format' is:
  821.  
  822.           (""
  823.            modeline-modified
  824.            modeline-buffer-identification
  825.            "   "
  826.            global-mode-string
  827.            "   %[("
  828.            mode-name
  829.            modeline-process
  830.            minor-mode-alist
  831.            "%n"
  832.            ")%]----"
  833.            (line-number-mode "L%l--")
  834.            (-3 . "%p")
  835.            "-%-")
  836.  
  837.  - Variable: vc-mode
  838.      The variable `vc-mode', local in each buffer, records whether the
  839.      buffer's visited file is maintained with version control, and, if
  840.      so, which kind.  Its value is `nil' for no version control, or a
  841.      string that appears in the mode line.
  842.  
  843. 
  844. File: lispref.info,  Node: %-Constructs,  Prev: Modeline Variables,  Up: Modeline Format
  845.  
  846. `%'-Constructs in the ModeLine
  847. ------------------------------
  848.  
  849.    The following table lists the recognized `%'-constructs and what
  850. they mean.  In any construct except `%%', you can add a decimal integer
  851. after the `%' to specify how many characters to display.
  852.  
  853. `%b'
  854.      The current buffer name, obtained with the `buffer-name' function.
  855.      *Note Buffer Names::.
  856.  
  857. `%f'
  858.      The visited file name, obtained with the `buffer-file-name'
  859.      function.  *Note Buffer File Name::.
  860.  
  861. `%F'
  862.      The name of the selected frame.
  863.  
  864. `%c'
  865.      The current column number of point.
  866.  
  867. `%l'
  868.      The current line number of point.
  869.  
  870. `%*'
  871.      `%' if the buffer is read only (see `buffer-read-only');
  872.      `*' if the buffer is modified (see `buffer-modified-p');
  873.      `-' otherwise.  *Note Buffer Modification::.
  874.  
  875. `%+'
  876.      `*' if the buffer is modified (see `buffer-modified-p');
  877.      `%' if the buffer is read only (see `buffer-read-only');
  878.      `-' otherwise.  This differs from `%*' only for a modified
  879.      read-only buffer.  *Note Buffer Modification::.
  880.  
  881. `%&'
  882.      `*' if the buffer is modified, and `-' otherwise.
  883.  
  884. `%s'
  885.      The status of the subprocess belonging to the current buffer,
  886.      obtained with `process-status'.  *Note Process Information::.
  887.  
  888. `%l'
  889.      the current line number.
  890.  
  891. `%S'
  892.      the name of the selected frame; this is only meaningful under the
  893.      X Window System.  *Note Frame Name::.
  894.  
  895. `%t'
  896.      Whether the visited file is a text file or a binary file.  (This
  897.      is a meaningful distinction only on certain operating systems.)
  898.  
  899. `%p'
  900.      The percentage of the buffer text above the *top* of window, or
  901.      `Top', `Bottom' or `All'.
  902.  
  903. `%P'
  904.      The percentage of the buffer text that is above the *bottom* of
  905.      the window (which includes the text visible in the window, as well
  906.      as the text above the top), plus `Top' if the top of the buffer is
  907.      visible on screen; or `Bottom' or `All'.
  908.  
  909. `%n'
  910.      `Narrow' when narrowing is in effect; nothing otherwise (see
  911.      `narrow-to-region' in *Note Narrowing::).
  912.  
  913. `%['
  914.      An indication of the depth of recursive editing levels (not
  915.      counting minibuffer levels): one `[' for each editing level.
  916.      *Note Recursive Editing::.
  917.  
  918. `%]'
  919.      One `]' for each recursive editing level (not counting minibuffer
  920.      levels).
  921.  
  922. `%%'
  923.      The character `%'--this is how to include a literal `%' in a
  924.      string in which `%'-constructs are allowed.
  925.  
  926. `%-'
  927.      Dashes sufficient to fill the remainder of the modeline.
  928.  
  929.    The following two `%'-constructs are still supported, but they are
  930. obsolete, since you can get the same results with the variables
  931. `mode-name' and `global-mode-string'.
  932.  
  933. `%m'
  934.      The value of `mode-name'.
  935.  
  936. `%M'
  937.      The value of `global-mode-string'.  Currently, only `display-time'
  938.      modifies the value of `global-mode-string'.
  939.  
  940. 
  941. File: lispref.info,  Node: Hooks,  Prev: Modeline Format,  Up: Modes
  942.  
  943. Hooks
  944. =====
  945.  
  946.    A "hook" is a variable where you can store a function or functions
  947. to be called on a particular occasion by an existing program.  XEmacs
  948. provides hooks for the sake of customization.  Most often, hooks are set
  949. up in the `.emacs' file, but Lisp programs can set them also.  *Note
  950. Standard Hooks::, for a list of standard hook variables.
  951.  
  952.    Most of the hooks in XEmacs are "normal hooks".  These variables
  953. contain lists of functions to be called with no arguments.  The reason
  954. most hooks are normal hooks is so that you can use them in a uniform
  955. way.  You can usually tell when a hook is a normal hook, because its
  956. name ends in `-hook'.
  957.  
  958.    The recommended way to add a hook function to a normal hook is by
  959. calling `add-hook' (see below).  The hook functions may be any of the
  960. valid kinds of functions that `funcall' accepts (*note What Is a
  961. Function::.).  Most normal hook variables are initially void;
  962. `add-hook' knows how to deal with this.
  963.  
  964.    As for abnormal hooks, those whose names end in `-function' have a
  965. value that is a single function.  Those whose names end in `-hooks'
  966. have a value that is a list of functions.  Any hook that is abnormal is
  967. abnormal because a normal hook won't do the job; either the functions
  968. are called with arguments, or their values are meaningful.  The name
  969. shows you that the hook is abnormal and that you should look at its
  970. documentation string to see how to use it properly.
  971.  
  972.    Major mode functions are supposed to run a hook called the "mode
  973. hook" as the last step of initialization.  This makes it easy for a user
  974. to customize the behavior of the mode, by overriding the local variable
  975. assignments already made by the mode.  But hooks are used in other
  976. contexts too.  For example, the hook `suspend-hook' runs just before
  977. XEmacs suspends itself (*note Suspending XEmacs::.).
  978.  
  979.    Here's an expression that uses a mode hook to turn on Auto Fill mode
  980. when in Lisp Interaction mode:
  981.  
  982.      (add-hook 'lisp-interaction-mode-hook 'turn-on-auto-fill)
  983.  
  984.    The next example shows how to use a hook to customize the way XEmacs
  985. formats C code.  (People often have strong personal preferences for one
  986. format or another.)  Here the hook function is an anonymous lambda
  987. expression.
  988.  
  989.      (add-hook 'c-mode-hook
  990.        (function (lambda ()
  991.                    (setq c-indent-level 4
  992.                          c-argdecl-indent 0
  993.                          c-label-offset -4
  994.                          c-continued-statement-indent 0
  995.                          c-brace-offset 0
  996.                          comment-column 40))))
  997.      
  998.      (setq c++-mode-hook c-mode-hook)
  999.  
  1000.    The final example shows how the appearance of the modeline can be
  1001. modified for a particular class of buffers only.
  1002.  
  1003.      (add-hook 'text-mode-hook
  1004.        (function (lambda ()
  1005.                    (setq modeline-format
  1006.                          '(modeline-modified
  1007.                            "Emacs: %14b"
  1008.                            "  "
  1009.                            default-directory
  1010.                            " "
  1011.                            global-mode-string
  1012.                            "%[("
  1013.                            mode-name
  1014.                            minor-mode-alist
  1015.                            "%n"
  1016.                            modeline-process
  1017.                            ") %]---"
  1018.                            (-3 . "%p")
  1019.                            "-%-")))))
  1020.  
  1021.    At the appropriate time, XEmacs uses the `run-hooks' function to run
  1022. particular hooks.  This function calls the hook functions you have
  1023. added with `add-hooks'.
  1024.  
  1025.  - Function: run-hooks &rest HOOKVAR
  1026.      This function takes one or more hook variable names as arguments,
  1027.      and runs each hook in turn.  Each HOOKVAR argument should be a
  1028.      symbol that is a hook variable.  These arguments are processed in
  1029.      the order specified.
  1030.  
  1031.      If a hook variable has a non-`nil' value, that value may be a
  1032.      function or a list of functions.  If the value is a function
  1033.      (either a lambda expression or a symbol with a function
  1034.      definition), it is called.  If it is a list, the elements are
  1035.      called, in order.  The hook functions are called with no arguments.
  1036.  
  1037.      For example, here's how `emacs-lisp-mode' runs its mode hook:
  1038.  
  1039.           (run-hooks 'emacs-lisp-mode-hook)
  1040.  
  1041.  - Function: add-hook HOOK FUNCTION &optional APPEND LOCAL
  1042.      This function is the handy way to add function FUNCTION to hook
  1043.      variable HOOK.  The argument FUNCTION may be any valid Lisp
  1044.      function with the proper number of arguments.  For example,
  1045.  
  1046.           (add-hook 'text-mode-hook 'my-text-hook-function)
  1047.  
  1048.      adds `my-text-hook-function' to the hook called `text-mode-hook'.
  1049.  
  1050.      You can use `add-hook' for abnormal hooks as well as for normal
  1051.      hooks.
  1052.  
  1053.      It is best to design your hook functions so that the order in
  1054.      which they are executed does not matter.  Any dependence on the
  1055.      order is "asking for trouble."  However, the order is predictable:
  1056.      normally, FUNCTION goes at the front of the hook list, so it will
  1057.      be executed first (barring another `add-hook' call).
  1058.  
  1059.      If the optional argument APPEND is non-`nil', the new hook
  1060.      function goes at the end of the hook list and will be executed
  1061.      last.
  1062.  
  1063.      If LOCAL is non-`nil', that says to make the new hook function
  1064.      local to the current buffer.  Before you can do this, you must
  1065.      make the hook itself buffer-local by calling `make-local-hook'
  1066.      (*not* `make-local-variable').  If the hook itself is not
  1067.      buffer-local, then the value of LOCAL makes no difference--the
  1068.      hook function is always global.
  1069.  
  1070.  - Function: remove-hook HOOK FUNCTION &optional LOCAL
  1071.      This function removes FUNCTION from the hook variable HOOK.
  1072.  
  1073.      If LOCAL is non-`nil', that says to remove FUNCTION from the local
  1074.      hook list instead of from the global hook list.  If the hook
  1075.      itself is not buffer-local, then the value of LOCAL makes no
  1076.      difference.
  1077.  
  1078.  - Function: make-local-hook HOOK
  1079.      This function makes the hook variable `hook' local to the current
  1080.      buffer.  When a hook variable is local, it can have local and
  1081.      global hook functions, and `run-hooks' runs all of them.
  1082.  
  1083.      This function works by making `t' an element of the buffer-local
  1084.      value.  That serves as a flag to use the hook functions in the
  1085.      default value of the hook variable as well as those in the local
  1086.      value.  Since `run-hooks' understands this flag, `make-local-hook'
  1087.      works with all normal hooks.  It works for only some non-normal
  1088.      hooks--those whose callers have been updated to understand this
  1089.      meaning of `t'.
  1090.  
  1091.      Do not use `make-local-variable' directly for hook variables; it is
  1092.      not sufficient.
  1093.  
  1094. 
  1095. File: lispref.info,  Node: Documentation,  Next: Files,  Prev: Modes,  Up: Top
  1096.  
  1097. Documentation
  1098. *************
  1099.  
  1100.    XEmacs Lisp has convenient on-line help facilities, most of which
  1101. derive their information from the documentation strings associated with
  1102. functions and variables.  This chapter describes how to write good
  1103. documentation strings for your Lisp programs, as well as how to write
  1104. programs to access documentation.
  1105.  
  1106.    Note that the documentation strings for XEmacs are not the same thing
  1107. as the XEmacs manual.  Manuals have their own source files, written in
  1108. the Texinfo language; documentation strings are specified in the
  1109. definitions of the functions and variables they apply to.  A collection
  1110. of documentation strings is not sufficient as a manual because a good
  1111. manual is not organized in that fashion; it is organized in terms of
  1112. topics of discussion.
  1113.  
  1114. * Menu:
  1115.  
  1116. * Documentation Basics::      Good style for doc strings.
  1117.                                 Where to put them.  How XEmacs stores them.
  1118. * Accessing Documentation::   How Lisp programs can access doc strings.
  1119. * Keys in Documentation::     Substituting current key bindings.
  1120. * Describing Characters::     Making printable descriptions of
  1121.                                 non-printing characters and key sequences.
  1122. * Help Functions::            Subroutines used by XEmacs help facilities.
  1123. * Obsoleteness::          Upgrading Lisp functionality over time.
  1124.  
  1125. 
  1126. File: lispref.info,  Node: Documentation Basics,  Next: Accessing Documentation,  Up: Documentation
  1127.  
  1128. Documentation Basics
  1129. ====================
  1130.  
  1131.    A documentation string is written using the Lisp syntax for strings,
  1132. with double-quote characters surrounding the text of the string.  This
  1133. is because it really is a Lisp string object.  The string serves as
  1134. documentation when it is written in the proper place in the definition
  1135. of a function or variable.  In a function definition, the documentation
  1136. string follows the argument list.  In a variable definition, the
  1137. documentation string follows the initial value of the variable.
  1138.  
  1139.    When you write a documentation string, make the first line a complete
  1140. sentence (or two complete sentences) since some commands, such as
  1141. `apropos', show only the first line of a multi-line documentation
  1142. string.  Also, you should not indent the second line of a documentation
  1143. string, if you have one, because that looks odd when you use `C-h f'
  1144. (`describe-function') or `C-h v' (`describe-variable').  *Note
  1145. Documentation Tips::.
  1146.  
  1147.    Documentation strings may contain several special substrings, which
  1148. stand for key bindings to be looked up in the current keymaps when the
  1149. documentation is displayed.  This allows documentation strings to refer
  1150. to the keys for related commands and be accurate even when a user
  1151. rearranges the key bindings.  (*Note Accessing Documentation::.)
  1152.  
  1153.    Within the Lisp world, a documentation string is accessible through
  1154. the function or variable that it describes:
  1155.  
  1156.    * The documentation for a function is stored in the function
  1157.      definition itself (*note Lambda Expressions::.).  The function
  1158.      `documentation' knows how to extract it.
  1159.  
  1160.    * The documentation for a variable is stored in the variable's
  1161.      property list under the property name `variable-documentation'.
  1162.      The function `documentation-property' knows how to extract it.
  1163.  
  1164.    To save space, the documentation for preloaded functions and
  1165. variables (including primitive functions and autoloaded functions) is
  1166. stored in the "internal doc file" `DOC'.  The documentation for
  1167. functions and variables loaded during the XEmacs session from
  1168. byte-compiled files is stored in those very same byte-compiled files
  1169. (*note Docs and Compilation::.).
  1170.  
  1171.    XEmacs does not keep documentation strings in memory unless
  1172. necessary.  Instead, XEmacs maintains, for preloaded symbols, an
  1173. integer offset into the internal doc file, and for symbols loaded from
  1174. byte-compiled files, a list containing the filename of the
  1175. byte-compiled file and an integer offset, in place of the documentation
  1176. string.  The functions `documentation' and `documentation-property' use
  1177. that information to read the documentation from the appropriate file;
  1178. this is transparent to the user.
  1179.  
  1180.    For information on the uses of documentation strings, see *Note
  1181. Help: (emacs)Help.
  1182.  
  1183.    The `emacs/lib-src' directory contains two utilities that you can
  1184. use to print nice-looking hardcopy for the file
  1185. `emacs/etc/DOC-VERSION'.  These are `sorted-doc.c' and `digest-doc.c'.
  1186.  
  1187.